javax.realtime
Class ImmortalPhysicalMemory

java.lang.Object
  javax.realtime.MemoryArea
      javax.realtime.ImmortalPhysicalMemory

public abstract class ImmortalPhysicalMemory

extends MemoryArea

An instance of ImmortalPhysicalMemory allows objects to be allocated from a range of physical memory with particular attributes, determined by their memory type. This memory area has the same restrictive set of assignment rules as ImmortalPhysicalMemory memory areas, and may be used in any execution context where ImmortalPhysicalMemory is appropriate.

Methods from ImmortalPhysicalMemory should be overridden only by methods that use super.

Field Summary

Fields inherited from class javax.realtime.MemoryArea

logic, sizeEstimator, sizeInBytes

Constructor Summary

ImmortalPhysicalMemory(java.lang.Object type, long size)
Create an instance with the given parameters.

ImmortalPhysicalMemory(java.lang.Object type, long base, long size)
Create an instance with the given parameters.

ImmortalPhysicalMemory(java.lang.Object type, long size, java.lang.Runnable logic)
Create an instance with the given parameters.

ImmortalPhysicalMemory(java.lang.Object type, long base, SizeEstimator size)
Create an instance with the given parameters.

ImmortalPhysicalMemory(java.lang.Object type, long base, SizeEstimator size, java.lang.Runnable logic)
Not currently implemented

ImmortalPhysicalMemory(java.lang.Object type, SizeEstimator size)
Create an instance with the given parameters.

Methods inherited from class javax.realtime.MemoryArea

enter, enter, executeInArea, getMemoryArea, memoryConsumed, memoryRemaining, newArray, newInstance, newInstance

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImmortalPhysicalMemory

public ImmortalPhysicalMemory(java.lang.Object type,
                              long size)

Create an instance with the given parameters.

Not currently implemented

Parameters:

type - An instance of Object representing the type of memory required (e.g., dma, shared) - used to define the base address and control the mapping. If the required memory has more than one attribute type may be an array of objects. If type is null or a reference to an array with no entries, any type of memory is acceptable.

size - The size of the area in bytes.

Throws:

java.lang.SecurityException - Thrown if the application doesn't have permissions to access physical memory or the given type of memory.

- HREF="UnsupportedPhysicalMemoryException.html"> UnsupportedPhysicalMemoryException Thrown if the underlying hardware does not support the given type, or if no matching PhysicalMemoryTypeFilter has been registered with the .

- HREF="MemoryTypeConflictException.html"> MemoryTypeConflictException Thrown if type specifies incompatible memory attributes.

java.lang.IllegalArgumentException - Thrown if size is less than zero.

java.lang.OutOfMemoryError - Thrown if there is insufficient memory for the ImmortalPhysicalMemory object or for the backing memory.

- HREF="SizeOutOfBoundsException.html"> SizeOutOfBoundsException Thrown if the size extends into an invalid range of memory.

ImmortalPhysicalMemory

public ImmortalPhysicalMemory(java.lang.Object type,
                              long base,
                              long size)

Create an instance with the given parameters.

Not currently implemented

Parameters:

type - An instance of Object or an array of objects representing the type of memory required (e.g., dma, shared) - used to define the base address and control the mapping. If the required memory has more than one attribute type may be an array of objects. If type is null or a reference to an array with no entries, any type of memory is acceptable.

base - The physical memory address of the area.

size - The size of the area in bytes.

Throws:

java.lang.SecurityException - Thrown if the application doesn't have permissions to access physical memory or the given range of memory.

OffsetOutOfBoundsException - Thrown if the base address is invalid.

SizeOutOfBoundsException - Thrown if the size extends into an invalid range of memory.

- HREF="UnsupportedPhysicalMemoryException.html"> UnsupportedPhysicalMemoryException Thrown if the underlying hardware does not support the given type, or if no matching PhysicalMemoryTypeFilter has been registered with the PhysicalMemoryManager.

MemoryTypeConflictException - Thrown if the specified base does not point to memory that matches the requested type, or if type specifies incompatible memory attributes.

java.lang.IllegalArgumentException - Thrown if size is less than zero. IllegalArgumentException may also be thrown if base plus size would be greater than the maximum physical address supported by the processor.

MemoryInUseException - Thrown if the specified memory is already in use.

java.lang.OutOfMemoryError - Thrown if there is insufficient memory for the ImmortalPhysicalMemory object or for the backing memory.

ImmortalPhysicalMemory

public ImmortalPhysicalMemory(java.lang.Object type,
                              SizeEstimator size)

Create an instance with the given parameters.

Not currently implemented

Parameters:

type - An instance of Object or an array of objects representing the type of memory required (e.g., dma, shared) - used to define the base address and control the mapping. If the required memory has more than one attribute type may be an array of objects. If type is null or a reference to an array with no entries, any type of memory is acceptable.

size - The size of the area in bytes.

Throws:

java.lang.SecurityException - Thrown if the application doesn't have permissions to access physical memory or the given type of memory.

SizeOutOfBoundsException - Thrown if the size estimate from size extends into an invalid range of memory.

UnsupportedPhysicalMemoryException - Thrown if the underlying hardware does not support the given type, or if no matching PhysicalMemoryTypeFilter has been registered with the PhysicalMemoryManager.

MemoryTypeConflictException - Thrown if type specifies incompatible memory attributes.

java.lang.IllegalArgumentException - Thrown if size is null.

java.lang.OutOfMemoryError - Thrown if there is insufficient memory for the ImmortalPhysicalMemory object or for the backing memory.

ImmortalPhysicalMemory

public ImmortalPhysicalMemory(java.lang.Object type,
                              long base,
                              SizeEstimator size)

Create an instance with the given parameters.

Not currently implemented

Parameters:

type - An instance of Object or an array of objects representing the type of memory required (e.g., dma, shared) - used to define the base address and control the mapping. If the required memory has more than one attribute type may be an array of objects. If type is null or a reference to an array with no entries, any type of memory is acceptable.

base - The physical memory address of the area.

size - The size of the area in bytes.

Throws:

java.lang.SecurityException - Thrown if the application doesn't have permissions to access physical memory or the given type of memory.

- HREF="OffsetOutOfBoundsException.html"> OffsetOutOfBoundsException Thrown if the base address is invalid.

- HREF="SizeOutOfBoundsException.html"> SizeOutOfBoundsException Thrown if the size estimate from size extends into an invalid range of memory.

- HREF="UnsupportedPhysicalMemoryException.html"> UnsupportedPhysicalMemoryException Thrown if the underlying hardware does not support the given type, or if no matching PhysicalMemoryTypeFilter has been registered with the PhysicalMemoryManager.

- HREF="MemoryTypeConflictException.html"> MemoryTypeConflictException Thrown if the specified base does not point to memory that matches the requested type, or if type specifies incompatible memory attributes.

java.lang.IllegalArgumentException - Thrown if size is null. IllegalArgumentException may also be thrown if base plus the size indicated by size would be greater than the maximum physical address supported by the processor.

- HREF="MemoryInUseException.html"> MemoryInUseException Thrown if the specified memory is already in use.

java.lang.OutOfMemoryError - Thrown if there is insufficient memory for the ImmortalPhysicalMemory object or for the backing memory.

ImmortalPhysicalMemory

public ImmortalPhysicalMemory(java.lang.Object type,
                              long size,
                              java.lang.Runnable logic)

Create an instance with the given parameters.

Not currently implemented

Parameters:

type - An instance of Object or an array of objects representing the type of memory required (e.g., dma, shared) - used to define the base address and control the mapping. If the required memory has more than one attribute type may be an array of objects. If type is null or a reference to an array with no entries, any type of memory is acceptable.

size - The size of the area in bytes.

logic - The run() method of this object will be called whenever MemoryArea.enter() is called. If logic is null, logic must be supplied when the memory area is entered.

Throws:

java.lang.SecurityException - Thrown if the application doesn't have permissions to access physical memory or the given type of memory.

- HREF="SizeOutOfBoundsException.html">SizeOutOfBoundsException Thrown if size extends into an invalid range of memory.

- HREF="UnsupportedPhysicalMemoryException.html"> UnsupportedPhysicalMemoryException Thrown if the underlying hardware does not support the given type, or if no matching PhysicalMemoryTypeFilter has been registered with the PhysicalMemoryManager.

java.lang.IllegalArgumentException - Thrown if size is negative.

- HREF="MemoryTypeConflictException.html"> MemoryTypeConflictException Thrown if the specified base does not point to memory that matches the requested type, or if type specifies incompatible memory attributes.

java.lang.OutOfMemoryError - Thrown if there is insufficient memory for the ImmortalPhysicalMemory object or for the backing memory.

- HREF="IllegalAssignmentError.html"> IllegalAssignmentError Thrown if storing logic in this would violate the assignment rules.

ImmortalPhysicalMemory

public ImmortalPhysicalMemory(java.lang.Object type,
                              long base,
                              SizeEstimator size,
                              java.lang.Runnable logic)

Not currently implemented

Parameters:

type - An instance of Object or an array of objects representing the type of memory required (e.g., dma, shared) - used to define the base address and control the mapping. If the required memory has more than one attribute type may be an array of objects. If type is null or a reference to an array with no entries, any type of memory is acceptable.

base - The physical memory address of the area.

size - The size of the area in bytes.

logic - The run() method of this object will be called whenever MemoryArea.enter() is called. If logic is null, logic must be supplied when the memory area is entered.

Throws:

java.lang.SecurityException - Thrown if the application doesn't have permissions to access physical memory or the given type of memory.

- HREF="OffsetOutOfBoundsException.html"> OffsetOutOfBoundsException Thrown if the base address is invalid.

- HREF="SizeOutOfBoundsException.html">SizeOutOfBoundsException Thrown if the size estimate from size extends into an invalid range of memory.

- HREF="UnsupportedPhysicalMemoryException.html"> UnsupportedPhysicalMemoryException Thrown if the underlying hardware does not support the given type, or if no matching PhysicalMemoryTypeFilter has been registered with the PhysicalMemoryManager.

- HREF="MemoryTypeConflictException.html"> MemoryTypeConflictException Thrown if the specified base does not point to memory that matches the requested type, or if type specifies incompatible memory attributes.

java.lang.IllegalArgumentException - Thrown if size is null. IllegalArgumentException may also be thrown if base plus the size indicated by size would be greater than the maximum physical address supported by the processor.

- HREF="MemoryInUseException.html"> MemoryInUseException Thrown if the specified memory is already in use.

java.lang.OutOfMemoryError - Thrown if there is insufficient memory for the ImmortalPhysicalMemory object or for the backing memory.

- HREF="IllegalAssignmentError.html"> IllegalAssignmentError Thrown if storing logic in this would violate the assignment rules.